/*
 * Copyright 2017-2022 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.expressions.parser;

import io.micronaut.core.annotation.Internal;
import org.jspecify.annotations.NonNull;
import io.micronaut.expressions.parser.ast.ExpressionNode;
import io.micronaut.expressions.parser.exception.ExpressionParsingException;

/**
 * Interface for evaluated expression parser.
 *
 * @author Sergey Gavrilov
 * @since 4.0.0
 */
@Internal
public sealed interface EvaluatedExpressionParser permits SingleEvaluatedExpressionParser,
    CompoundEvaluatedExpressionParser {
    /**
     * Parse expression into AST.
     *
     * @return expression AST
     * @throws ExpressionParsingException when expression violates syntactic rules
     */
    @NonNull
    ExpressionNode parse() throws ExpressionParsingException;
}
